/**
 * \file Object.h
 *
 * ICC General Code Base
 * Written 2010-2011, by Anthony Berlin and Alexander Carlqvist
 *
 * This file is part of ICC.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef OBJECT_H
#define OBJECT_H

#include <gc/gc_cpp.h>

#include <string>

/**
 * \class Object
 * \brief This is the base class for all other classes to derive from.
 */
class Object : public gc
{
public:
    Object() { };
    Object(const Object& other);
    Object(const Object* other);
    virtual ~Object() { };

    /// Assignment operator \c =.
    virtual Object& operator=(const Object& rhs);

    /// Compare the equality of this \c Object with another \c Object.
    virtual bool operator==(const Object& other) const;
    virtual bool operator==(const Object* other) const;
    virtual bool operator!=(const Object& other) const;
    virtual bool operator!=(const Object* other) const;

    /// Convert this \c Object to a \c string.
    virtual std::string to_string() const;

    /// Convert this \c Object to a string of \c char*.
    virtual char* to_chars() const;

    /// Print a text version of this \c Object.
    virtual void print() const;
};

#endif // OBJECT_H
